
        <HTML>
		<HEAD>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
		<meta name="description" content="Flash MX 2004 ActionScript2.0 Library: LightSource - Wright Internet Solutions">
		<meta name="keywords" content="geometry,LightSource,Flash,MX,2004,ActionScript,ActionScript2.0,AS2.0 Library,AS2,AS2 Library,Wright Internet Solutions,Wright,class,documentation,methods,functions,interfaces,JavaScript,Java">
		<TITLE>WIS AS2 Library : com.wis.math.geom.util.LightSource Documentation</TITLE>

		<STYLE><!--
		HR.small{height:1px; width:100%; background:#E7BFA3; border: 0px;}
		HR.big{height:4px; width:100%; background:#E7BFA3; border: 0px;}
		A:hover{text-decoration: underline}
		A{text-decoration: none; color: #993333}
		code{font-family: monospace; font-size: 12px; color: #666666;}
		.methodAttributesTitle{font-size: 12px; font-weight: bold; color: #7B779C}
		.ToC{font-size: 12px; font-weight: bold; color: #993333}
		.methodTitle{font-size: 14px; font-weight: bold; color: #993333}
		.groupTitle{font-size: 18px; font-weight: bold; color: #993333}
		.sectionTitle{font-size: 22px; font-weight: bold; color: #993333}
		.majorTitle{font-size: 32px; font-weight: bold; color: #993333; padding-bottom:100px;}
		.methodsDiv{margin-left:40px;}
		.footer{font-size: 11px; color: #666666;}
		body{font-family: arial,sans-serif; font-size: 12px;}
		//--></STYLE>

		</HEAD>
		<BODY bgColor='#ffffcc'>
		<P class='majorTitle'>com.wis.math.geom.util.LightSource Documentation</P>


		<P><B>Author:</B> <a href='mailto:wisolutions2002@shaw.ca?subject=wisASLibrary LightSource Class'>Richard Wright</a><BR>
		<B>Last Modified:</B> 08/05/04 21:29:29<HR class='big'>

		<P class='sectionTitle'>Summary</P>
		<P class='ToC'>com.wis.math.geom.util.LightSource class:</P>
		<div class='methodsDiv'><a href='#classinfo'>- description</a></div>
<P class='ToC'>com.wis.math.geom.util.LightSource Properties:</P><div class='methodsDiv'>
<a href='#$pos'>- $pos</a><br>
<a href='#$v1'>- $v1</a><br>
<a href='#$v2'>- $v2</a><br>
<a href='#$dir'>- $dir</a><br>
<a href='#$color'>- $color</a><br>
<a href='#$tColor'>- $tColor</a><br>
<a href='#$sampleV1'>- $sampleV1</a><br>
<a href='#$sampleV2(Boolean)'>- $sampleV2(Boolean)</a><br>
<a href='#$spotLight'>- $spotLight</a><br>
<a href='#$minSampleDepth'>- $minSampleDepth</a><br>
<a href='#$maxSampleDepth'>- $maxSampleDepth</a><br>
<a href='#$innerAngleCos'>- $innerAngleCos</a><br>
<a href='#$outerAngleCos'>- $outerAngleCos</a><br>
<a href='#$outerAngle'>- $outerAngle</a><br>
<a href='#$angleDiff'>- $angleDiff</a><br>
<a href='#$jitterAmnt'>- $jitterAmnt</a><br>
<a href='#$trans'>- $trans</a><br>
<a href='#$objStack'>- $objStack</a><br>
</div><br>
<P class='ToC'>com.wis.math.geom.util.LightSource Methods:</P><div class='methodsDiv'>
<a href='# transform'>-  transform</a><br>
<a href='# copy'>-  copy</a><br>
<a href='# getLightColorAt'>-  getLightColorAt</a><br>
<a href='# sCurve'>-  sCurve</a><br>
<a href='# samplePoint'>-  samplePoint</a><br>
</div><br>

		<HR class='big'>
		<P class='sectionTitle'><A name='classinfo'></A>com.wis.math.geom.util.LightSource <I>class</I></P>
		<P> <span class='methodTitle'>version:</span> 1.7</P>
		<P class="methodTitle">description:</P>
		<P>Implements the behaviours of the LightSource Class.
 <p>
 		        Provides utlity methods for the IObj interface based on JS
 RayTracer2 by John Haggerty.
 </P>
		<P class="methodTitle">usage:</P> <pre>var inst:LightSource = new LightSource(ray,color);</pre>

<P> <span class='methodTitle'>parameters:</span>
				<ul>
<li>      ray (Vector)  -- a position Vector object.</li>
<li>      color (Col)  -- a Col object.</li>
</ul>

			<HR class='small'>
			<P class='groupTitle'><A name='properties'></A>com.wis.math.geom.util.LightSource Properties:</P>
			<div class='methodsDiv' >


				<P class='methodTitle'><A name='$pos'></A><u> $pos</u></P>
				<P> (Vector)  -- a position Vector object.</P>

				<P class='methodTitle'><A name='$v1'></A><u> $v1</u></P>
				<P> (Vector)  -- a direction Vector object used to define area light.</P>

				<P class='methodTitle'><A name='$v2'></A><u> $v2</u></P>
				<P> (Vector)  -- a direction Vector object used to define area light.</P>

				<P class='methodTitle'><A name='$dir'></A><u> $dir</u></P>
				<P> (Vector)  -- a direction Vector object used to define spot light.</P>

				<P class='methodTitle'><A name='$color'></A><u> $color</u></P>
				<P> (Col)  -- a Col object.</P>

				<P class='methodTitle'><A name='$tColor'></A><u> $tColor</u></P>
				<P> (Color)  -- a target Color object.</P>

				<P class='methodTitle'><A name='$sampleV1'></A><u> $sampleV1</u></P>
				<P> (Boolean)  -- default is 'false', used to flag area light method steps.</P>

				<P class='methodTitle'><A name='$sampleV2(Boolean)'></A><u> $sampleV2(Boolean)</u></P>
				<P> -- default is 'false', used to flag area light method steps.</P>

				<P class='methodTitle'><A name='$spotLight'></A><u> $spotLight</u></P>
				<P> (Boolean)  -- default is 'false', used to flag spot light method steps.</P>

				<P class='methodTitle'><A name='$minSampleDepth'></A><u> $minSampleDepth</u></P>
				<P> (Number)  -- a positive integer 0 ++.</P>

				<P class='methodTitle'><A name='$maxSampleDepth'></A><u> $maxSampleDepth</u></P>
				<P> (Number)  -- a positive integer.</P>

				<P class='methodTitle'><A name='$innerAngleCos'></A><u> $innerAngleCos</u></P>
				<P> (Number)  -- a real number between 0 and 1.</P>

				<P class='methodTitle'><A name='$outerAngleCos'></A><u> $outerAngleCos</u></P>
				<P> (Number)  -- a real number between 0 and 1.</P>

				<P class='methodTitle'><A name='$outerAngle'></A><u> $outerAngle</u></P>
				<P> (Number)  -- a real number.</P>

				<P class='methodTitle'><A name='$angleDiff'></A><u> $angleDiff</u></P>
				<P> (Number)  -- a real number.</P>

				<P class='methodTitle'><A name='$jitterAmnt'></A><u> $jitterAmnt</u></P>
				<P> (Number)  -- a real number.</P>

				<P class='methodTitle'><A name='$trans'></A><u> $trans</u></P>
				<P> (Transformation)  -- a Transformation object.</P>

				<P class='methodTitle'><A name='$objStack'></A><u> $objStack</u></P>
				<P> (Array)  -- a list of shape objects.</P>
</div>

			<HR class='small'>
			<P class='groupTitle'><A name='methods'></A>com.wis.math.geom.util.LightSource Methods:</P>
			<div class='methodsDiv' >


				<P class='methodTitle'><A name=' transform'></A><u>  transform</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Transforms this instance's Vector objects.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.transform(trans);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  trans   (Transformation)  -- a Transformation object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Void)
    </P>

				<P class='methodTitle'><A name=' copy'></A><u>  copy</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Creates a copy of this instance's properties.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.copy();</pre>
     </P>
<P><span class='methodAttributesTitle'>returns:</span> (LightSource)  -- returns a new LightSource object, a copy of this instance's properties.
    </P>

				<P class='methodTitle'><A name=' getLightColorAt'></A><u>  getLightColorAt</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Called by super's 'getColorAt' method to define a new Col object.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.getLightColorAt(objs,pos);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  objs   (Array)  -- a list of shape objects.</li>
<li>  pos   (Vector)  -- a position Vector object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Col)  -- returns a new Col object.
    </P>

				<P class='methodTitle'><A name=' sCurve'></A><u>  sCurve</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Static -- Creates a derivative for a 3rd degree polynomial graph.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.sCurve(x);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  x   (Number)  -- a real number.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Number)  -- a real number, a derivative for a 3rd degree polynomial graph.
    </P>

				<P class='methodTitle'><A name=' samplePoint'></A><u>  samplePoint</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Checks for any intersection at all between 'point' and 'pos' Vector objects.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.samplePoint(objs,point,pos);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  objs   (Array)  -- a list of shape objects.</li>
<li>  point   (Vector)  -- a position Vector object.</li>
<li>  pos   (Vector)  -- a position Vector object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Col)  -- returns a new Col object.
    </P>
</div>

			<BR>
			<BR>
			<HR class='big'>
			<span class="footer">generated with <A href='http://blog.klaustrofobik.org/' target='_blank'>AS2docGenerator beta 0.5.3</A></span>
			</BODY>
			</HTML>

